home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat2 / stat.0 < prev    next >
Text File  |  1996-09-01  |  7KB  |  163 lines
  1.  
  2. STAT(2)                    UNIX Programmer's Manual                    STAT(2)
  3.  
  4. NNAAMMEE
  5.      ssttaatt, llssttaatt, ffssttaatt - get file status
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<ssyyss//ttyyppeess..hh>>
  9.      ##iinncclluuddee <<ssyyss//ssttaatt..hh>>
  10.  
  11.      _i_n_t
  12.      ssttaatt(_c_o_n_s_t _c_h_a_r _*_p_a_t_h, _s_t_r_u_c_t _s_t_a_t _*_s_b)
  13.  
  14.      _i_n_t
  15.      llssttaatt(_c_o_n_s_t _c_h_a_r _*_p_a_t_h, _s_t_r_u_c_t _s_t_a_t _*_s_b)
  16.  
  17.      _i_n_t
  18.      ffssttaatt(_i_n_t _f_d, _s_t_r_u_c_t _s_t_a_t _*_s_b)
  19.  
  20. DDEESSCCRRIIPPTTIIOONN
  21.      The ssttaatt() function obtains information about the file pointed to by
  22.      _p_a_t_h. Read, write or execute permission of the named file is not re-
  23.      quired, but all directories listed in the path name leading to the file
  24.      must be searchable.
  25.  
  26.      LLssttaatt() is like ssttaatt() except in the case where the named file is a sym-
  27.      bolic link, in which case llssttaatt() returns information about the link,
  28.      while ssttaatt() returns information about the file the link references.  Un-
  29.      like other filesystem objects, symbolic links do not have an owner,
  30.      group, access mode, times, etc.  Instead, these attributes are taken from
  31.      the directory that contains the link.  The only attributes returned from
  32.      an llssttaatt() that refer to the symbolic link itself are the file type
  33.      (S_IFLNK), size, blocks, and link count (always 1).
  34.  
  35.      The ffssttaatt() obtains the same information about an open file known by the
  36.      file descriptor _f_d.
  37.  
  38.      The _s_b argument is a pointer to a ssttaatt() structure as defined by
  39.      <_s_y_s_/_s_t_a_t_._h> (shown below) and into which information is placed concern-
  40.      ing the file.
  41.  
  42.      struct stat {
  43.          dev_t    st_dev;    /* device inode resides on */
  44.          ino_t    st_ino;    /* inode's number */
  45.          mode_t   st_mode;   /* inode protection mode */
  46.          nlink_t  st_nlink;  /* number or hard links to the file */
  47.          uid_t    st_uid;    /* user-id of owner */
  48.          gid_t    st_gid;    /* group-id of owner */
  49.          dev_t    st_rdev;   /* device type, for special file inode */
  50.          struct timespec st_atimespec;  /* time of last access */
  51.          struct timespec st_mtimespec;  /* time of last data modification */
  52.          struct timespec st_ctimespec;  /* time of last file status change */
  53.          off_t    st_size;   /* file size, in bytes */
  54.          quad_t   st_blocks; /* blocks allocated for file */
  55.          u_long   st_blksize;/* optimal file sys I/O ops blocksize */
  56.          u_long   st_flags;  /* user defined flags for file */
  57.          u_long   st_gen;    /* file generation number */
  58.      };
  59.  
  60.      The time-related fields of _s_t_r_u_c_t _s_t_a_t are as follows:
  61.  
  62.      st_atime     Time when file data last accessed.  Changed by the mknod(2),
  63.                    utimes(2) and read(2) system calls.
  64.  
  65.      st_mtime     Time when file data last modified.  Changed by the mknod(2),
  66.  
  67.                    utimes(2) and write(2) system calls.
  68.  
  69.      st_ctime     Time when file status was last changed (inode data modifica-
  70.                   tion).  Changed by the chmod(2),  chown(2),  link(2),
  71.                   mknod(2),  rename(2),  unlink(2),  utimes(2) and write(2)
  72.                   system calls.
  73.  
  74.      The size-related fields of the _s_t_r_u_c_t _s_t_a_t are as follows:
  75.  
  76.      st_blksize     The optimal I/O block size for the file.
  77.  
  78.      st_blocks      The actual number of blocks allocated for the file in
  79.                     512-byte units.  As short symbolic links are stored in the
  80.                     inode, this number may be zero.
  81.  
  82.      The status information word _s_t___m_o_d_e has the following bits:
  83.  
  84.      #define S_IFMT 0170000           /* type of file */
  85.      #define        S_IFIFO  0010000  /* named pipe (fifo) */
  86.      #define        S_IFCHR  0020000  /* character special */
  87.      #define        S_IFDIR  0040000  /* directory */
  88.      #define        S_IFBLK  0060000  /* block special */
  89.      #define        S_IFREG  0100000  /* regular */
  90.      #define        S_IFLNK  0120000  /* symbolic link */
  91.      #define        S_IFSOCK 0140000  /* socket */
  92.      #define S_ISUID 0004000  /* set user id on execution */
  93.      #define S_ISGID 0002000  /* set group id on execution */
  94.      #define S_ISVTX 0001000  /* save swapped text even after use */
  95.      #define S_IRUSR 0000400  /* read permission, owner */
  96.      #define S_IWUSR 0000200  /* write permission, owner */
  97.      #define S_IXUSR 0000100  /* execute/search permission, owner */
  98.  
  99.      For a list of access modes, see <_s_y_s_/_s_t_a_t_._h>, access(2) and chmod(2).
  100.  
  101. RREETTUURRNN VVAALLUUEESS
  102.      Upon successful completion a value of 0 is returned.  Otherwise, a value
  103.      of -1 is returned and _e_r_r_n_o is set to indicate the error.
  104.  
  105. CCOOMMPPAATTIIBBIILLIITTYY
  106.      Previous versions of the system used different types for the st_dev,
  107.      st_uid, st_gid, st_rdev, st_size, st_blksize and st_blocks fields.
  108.  
  109. EERRRROORRSS
  110.      SSttaatt() and llssttaatt() will fail if:
  111.  
  112.      [ENOTDIR]     A component of the path prefix is not a directory.
  113.  
  114.      [ENAMETOOLONG]
  115.                    A component of a pathname exceeded {NAME_MAX} characters,
  116.                    or an entire path name exceeded {PATH_MAX} characters.
  117.  
  118.      [ENOENT]      The named file does not exist.
  119.  
  120.      [EACCES]      Search permission is denied for a component of the path
  121.                    prefix.
  122.  
  123.      [ELOOP]       Too many symbolic links were encountered in translating the
  124.                    pathname.
  125.  
  126.      [EFAULT]      _S_b or _n_a_m_e points to an invalid address.
  127.  
  128.      [EIO]         An I/O error occurred while reading from or writing to the
  129.                    file system.
  130.  
  131.  
  132.  
  133.      FFssttaatt() will fail if:
  134.  
  135.      [EBADF]       _f_d is not a valid open file descriptor.
  136.  
  137.      [EFAULT]      _S_b points to an invalid address.
  138.  
  139.      [EIO]         An I/O error occurred while reading from or writing to the
  140.                    file system.
  141.  
  142. CCAAVVEEAATT
  143.      The fields in the stat structure currently marked _s_t___s_p_a_r_e_1, _s_t___s_p_a_r_e_2,
  144.      and _s_t___s_p_a_r_e_3 are present in preparation for inode time stamps expanding
  145.      to 64 bits.  This, however, can break certain programs that depend on the
  146.      time stamps being contiguous (in calls to utimes(2)).
  147.  
  148. SSEEEE AALLSSOO
  149.      chmod(2),  chown(2),  utimes(2) symlink(7)
  150.  
  151. BBUUGGSS
  152.      Applying fstat to a socket (and thus to a pipe) returns a zero'd buffer,
  153.      except for the blocksize field, and a unique device and inode number.
  154.  
  155. SSTTAANNDDAARRDDSS
  156.      The ssttaatt() and ffssttaatt() function calls are expected to conform to IEEE
  157.      Std1003.1-1988 (``POSIX'').
  158.  
  159. HHIISSTTOORRYY
  160.      A llssttaatt() function call appeared in 4.2BSD.
  161.  
  162. 4th Berkeley Distribution       April 19, 1994                               3
  163.